Help/Extending and Customizing SC/Style Guide/UGenHelpTemplate.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <title></title>
   7 <meta name="Generator" content="Cocoa HTML Writer">
   8 <meta name="CocoaVersion" content="949.46">
   9 <style type="text/css">
  10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
  11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
  12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
  13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
  14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
  15 span.s1 {font: 18.0px Helvetica}
  16 span.s2 {color: #0000bf}
  17 span.s3 {color: #0000bf}
  18 span.Apple-tab-span {white-space:pre}
  19 </style>
  20 </head>
  21 <body>
  22 <p class="p1"><span class="s1"><b>SomeUGen<span class="Apple-tab-span"> </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></b></span><b>explanation of the what SomeUGen does</b></p>
  23 <p class="p2"><br></p>
  24 <p class="p1"><b>SomeUGen.ar(arg1, arg2, mul, add)</b></p>
  25 <p class="p1"><b>SomeUGen.kr(arg1, arg2, mul, add)</b></p>
  26 <p class="p2"><br></p>
  27 <p class="p1">Here is a short prose explanation of what the UGen does, and any other relevant points.</p>
  28 <p class="p1"><b>arg1</b> - explanation of arg1 and default value if applicable</p>
  29 <p class="p1"><b>arg2</b> - explanation of arg2 and default value if applicable</p>
  30 <p class="p2"><br></p>
  31 <p class="p1"><b>See also:</b> <a href="../../UGens/Oscillators/SinOsc.html"><span class="s2">SinOsc</span></a> [other related UGens...]</p>
  32 <p class="p2"><br></p>
  33 <p class="p3"><br></p>
  34 <p class="p4">// what this example does</p>
  35 <p class="p5">x = { <span class="s3">SomeUGen</span>.ar(<span class="s3">XLine</span>.kr(2000, 200), 0, 0.5) }.play;</p>
  36 <p class="p5">x.free;</p>
  37 <p class="p3"><br></p>
  38 <p class="p4">// what this example does</p>
  39 <p class="p5">(</p>
  40 <p class="p5">x = SynthDef(\helpSomeUGen, {<span class="Apple-converted-space"> </span></p>
  41 <p class="p5"><span class="Apple-tab-span">     </span>Out.ar(0, <span class="s3">SomeUGen</span>.ar(<span class="s3">SinOsc</span>.ar(<span class="s3">XLine</span>.kr(1, 1000, 9), 0, 200, 800), 0, 0.25));<span class="Apple-converted-space"> </span></p>
  42 <p class="p5">}).play;<span class="Apple-converted-space"> </span></p>
  43 <p class="p5">)</p>
  44 <p class="p5">x.free;</p>
  45 </body>
  46 </html>